Metadata-Version: 2.1
Name: VWS Python
Version: 2020.6.19.0
Summary: Interact with the Vuforia Web Services (VWS) API.
Home-page: https://vws-python.readthedocs.io
Author: Adam Dangoor
Author-email: adamdangoor@gmail.com
License: MIT License
Description: |Build Status| |codecov| |PyPI| |Documentation Status|
        
        vws-python
        ==========
        
        Python library for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.
        
        Installation
        ------------
        
        .. code:: sh
        
           pip install vws-python
        
        This is tested on Python 3.7+.
        Get in touch with ``adamdangoor@gmail.com`` if you would like to use this with another language.
        
        Getting Started
        ---------------
        
        .. code:: python
        
           import io
        
           from vws import VWS, CloudRecoService
        
           server_access_key = '[server-access-key]'
           server_secret_key = '[server-secret-key]'
           client_access_key = '[client-access-key]'
           client_secret_key = '[client-secret-key]'
        
           vws_client = VWS(
               server_access_key=server_access_key,
               server_secret_key=server_secret_key,
           )
           cloud_reco_client = CloudRecoService(
               client_access_key=client_access_key,
               client_secret_key=client_secret_key,
           )
           name = 'my_image_name'
        
           with open('/path/to/image.png', 'rb') as my_image_file:
              my_image = io.BytesIO(my_image_file.read())
        
           target_id = vws_client.add_target(
               name=name,
               width=1,
               image=my_image,
               active_flag=True,
               application_metadata=None,
           )
           vws_client.wait_for_target_processed(target_id=target_id)
           matching_targets = cloud_reco_client.query(image=my_image)
        
           assert matching_targets[0].target_id == target_id
        
        
        Full Documentation
        ------------------
        
        See the `full documentation <https://vws-python.readthedocs.io/en/latest>`__.
        
        .. |Build Status| image:: https://github.com/VWS-Python/vws-python/workflows/CI/badge.svg
           :target: https://github.com/VWS-Python/vws-python/actions
        .. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-python/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/VWS-Python/vws-python
        .. |Documentation Status| image:: https://readthedocs.org/projects/vws-python/badge/?version=latest
           :target: https://vws-python.readthedocs.io/en/latest/?badge=latest
           :alt: Documentation Status
        .. |PyPI| image:: https://badge.fury.io/py/VWS-Python.svg
           :target: https://badge.fury.io/py/VWS-Python
        
Keywords: vuforia client
Platform: UNKNOWN
Classifier: Operating System :: POSIX
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3
Provides-Extra: dev
